WORKERS AHEAD!

You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.

To view the documentation for a specific Apereo CAS server release, please choose an appropriate version. The release schedule is available here.

Ehcache v3 Ticket Registry

Ehcache 3.x integration is enabled by including the following dependency in the WAR overlay:

<dependency>
  <groupId>org.apereo.cas</groupId>
  <artifactId>cas-server-support-ehcache3-ticket-registry</artifactId>
  <version>${cas.version}</version>
</dependency>

implementation "org.apereo.cas:cas-server-support-ehcache3-ticket-registry:${project.'cas.version'}"

dependencyManagement {
  imports {
    mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
  }
}

dependencies {  
  implementation "org.apereo.cas:cas-server-support-ehcache3-ticket-registry"
}

This registry stores tickets using the Ehcache 3.x caching library and an optional Terracotta cluster.

Actuator Endpoints

The following endpoints are provided:

The following settings and properties are available from the CAS configuration catalog:

_{The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.}


`cas.monitor.endpoints.jdbc.password-encoder.encoding-algorithm=` The encoding algorithm to use such as `MD5`. Relevant when the type used is `DEFAULT` or `GLIBC_CRYPT`. `org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.`
`cas.monitor.endpoints.jdbc.password-encoder.type=NONE` Define the password encoder type to use. Type may be specified as blank or `NONE` to disable password encoding. It may also refer to a fully-qualified class name that implements the Spring Security's `PasswordEncoder` interface if you wish you define your own encoder. The following types may be used: `NONE`: No password encoding (i.e. plain-text) takes place. `DEFAULT`: Use the `DefaultPasswordEncoder` of CAS. For message-digest algorithms via `character-encoding` and `encoding-algorithm`. `BCRYPT`: Use the `BCryptPasswordEncoder` based on the strength provided and an optional secret. `SCRYPT`: Use the `SCryptPasswordEncoder`. `PBKDF2`: Use the `Pbkdf2PasswordEncoder` based on the strength provided and an optional secret. `STANDARD`: Use the `StandardPasswordEncoder` based on the secret provided. `SSHA`: Use the `LdapShaPasswordEncoder` supports Ldap SHA and SSHA (salted-SHA). The values are base-64 encoded and have the label {SHA</code> or {SSHA</code> prepended to the encoded hash. `GLIBC_CRYPT`: Use the `GlibcCryptPasswordEncoder` based on the `encoding-algorithm`, strength provided and an optional secret. `org.example.MyEncoder`: An implementation of `PasswordEncoder` of your own choosing. `file:///path/to/script.groovy`: Path to a Groovy script charged with handling password encoding operations. `org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.`
`cas.monitor.endpoints.jdbc.driver-class=org.hsqldb.jdbcDriver` The JDBC driver used to connect to the database. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.password=` The database connection password. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.url=jdbc:hsqldb:mem:cas-hsql-database` The database connection URL. This setting supports the Spring Expression Language. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.user=sa` The database user. The database user must have sufficient permissions to be able to handle schema changes and updates, when needed. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`

_{The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This flag indicates that the presence of the setting is not immediately necessary in the end-user CAS configuration, because a default value is assigned or the activation of the feature is not conditionally controlled by the setting value.}


`cas.monitor.endpoints.jdbc.password-encoder.character-encoding=UTF-8` The encoding algorithm to use such as 'UTF-8'. Relevant when the type used is `DEFAULT`. `org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.`
`cas.monitor.endpoints.jdbc.password-encoder.secret=` Secret to use with `STANDARD`, `PBKDF2`, `BCRYPT`, `GLIBC_CRYPT` password encoders. Secret usually is an optional setting. `org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.`
`cas.monitor.endpoints.jdbc.password-encoder.strength=16` Strength or number of iterations to use for password hashing. Usually relevant when dealing with `PBKDF2` or `BCRYPT` encoders. Used by `GLIBC_CRYPT` encoders as well. `org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.`
`cas.monitor.endpoints.jdbc.autocommit=false` The default auto-commit behavior of connections in the pool. Determined whether queries such as update/insert should be immediately executed without waiting for an underlying transaction. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.batch-size=100` A non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.data-source-name=` Attempts to do a JNDI data source look up for the data source name specified. Will attempt to locate the data source object as is. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.ddl-auto=update` Hibernate feature to automatically validate and exports DDL to the schema. By default, creates and drops the schema automatically when a session is starts and ends. Setting the value to `validate` or `none` may be more desirable for production, but any of the following options can be used: `validate`: Validate the schema, but make no changes to the database. `update`: Update the schema. `create`: Create the schema, destroying previous data. `create-drop`: Drop the schema at the end of the session. `none`: Do nothing. Note that during a version migration where any schema has changed `create-drop` will result in the loss of all data as soon as CAS is started. For transient data like tickets this is probably not an issue, but in cases like the audit table important data could be lost. Using `update`, while safe for data, is confirmed to result in invalid database state. `validate` or `none` settings are likely the only safe options for production use. For more info, see this. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.default-catalog=` Qualifies unqualified table names with the given catalog in generated SQL. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.default-schema=` Qualify unqualified table names with the given schema/tablespace in generated SQL. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.dialect=org.hibernate.dialect.HSQLDialect` The database dialect is a configuration setting for platform independent software (JPA, Hibernate, etc) which allows such software to translate its generic SQL statements into vendor specific DDL, DML. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.fail-fast-timeout=1` Set the pool initialization failure timeout. Any value greater than zero will be treated as a timeout for pool initialization. The calling thread will be blocked from continuing until a successful connection to the database, or until the timeout is reached. If the timeout is reached, then a `PoolInitializationException` will be thrown. A value of zero will not prevent the pool from starting in the case that a connection cannot be obtained. However, upon start the pool will attempt to obtain a connection and validate that the `connectionTestQuery` and `connectionInitSql` are valid. If those validations fail, an exception will be thrown. If a connection cannot be obtained, the validation is skipped and the the pool will start and continue to try to obtain connections in the background. This can mean that callers to `DataSource#getConnection()` may encounter exceptions. A value less than zero will not bypass any connection attempt and validation during startup, and therefore the pool will start immediately. The pool will continue to try to obtain connections in the background. This can mean that callers to `DataSource#getConnection()` may encounter exceptions. Note that if this timeout value is greater than or equal to zero (0), and therefore an initial connection validation is performed, this timeout does not override the `connectionTimeout` or `validationTimeout`; they will be honored before this timeout is applied. The default value is one millisecond. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.fetch-size=100` Used to specify number of rows to be fetched in a select query. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.generate-statistics=false` Allow hibernate to generate query statistics. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.health-query=` The SQL query to be executed to test the validity of connections. This is for "legacy" databases that do not support the JDBC4 `Connection.isValid()` API. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.idle-timeout=PT10M` Controls the maximum amount of time that a connection is allowed to sit idle in the pool. This settings supports the `java.time.Duration` syntax ^[?]. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.isolate-internal-queries=false` This property determines whether data source isolates internal pool queries, such as the connection alive test, in their own transaction. Since these are typically read-only queries, it is rarely necessary to encapsulate them in their own transaction. This property only applies if `#autocommit` is disabled. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.isolation-level-name=ISOLATION_READ_COMMITTED` Defines the isolation level for transactions. @see org.springframework.transaction.TransactionDefinition `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.leak-threshold=3000` Controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.physical-naming-strategy-class-name=org.apereo.cas.hibernate.CasHibernatePhysicalNamingStrategy` Fully-qualified name of the class that can control the physical naming strategy of hibernate. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.propagation-behavior-name=PROPAGATION_REQUIRED` Defines the propagation behavior for transactions. @see org.springframework.transaction.TransactionDefinition `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.properties=` Additional settings provided by Hibernate (or the connection provider) in form of key-value pairs. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.query=` Query to execute in order to authenticate users via JDBC. Example: `SELECT username,password,enabled FROM users WHERE username=?` `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.read-only=false` Configures the Connections to be added to the pool as read-only Connections. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.role-prefix=` Prefix to add to the role. `org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jdbc.pool.keep-alive-time=0` This property controls the keepalive interval for a connection in the pool. An in-use connection will never be tested by the keepalive thread, only when it is idle will it be tested. Default is zero, which disables this feature. This settings supports the `java.time.Duration` syntax ^[?]. `org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.`
`cas.monitor.endpoints.jdbc.pool.max-size=18` Controls the maximum number of connections to keep in the pool, including both idle and in-use connections. `org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.`
`cas.monitor.endpoints.jdbc.pool.max-wait=PT2S` Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. This settings supports the `java.time.Duration` syntax ^[?]. `org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.`
`cas.monitor.endpoints.jdbc.pool.maximum-lifetime=PT10M` This property controls the maximum lifetime of a connection in the pool. When a connection reaches this timeout, even if recently used, it will be retired from the pool. An in-use connection will never be retired, only when it is idle will it be removed. This settings supports the `java.time.Duration` syntax ^[?]. `org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.`
`cas.monitor.endpoints.jdbc.pool.min-size=6` Controls the minimum size that the pool is allowed to reach, including both idle and in-use connections. `org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.`
`cas.monitor.endpoints.jdbc.pool.name=` Set the name of the connection pool. This is primarily used for the MBean to uniquely identify the pool configuration. `org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.`
`cas.monitor.endpoints.jdbc.pool.suspension=false` Whether or not pool suspension is allowed. There is a performance impact when pool suspension is enabled. Unless you need it (for a redundancy system for example) do not enable it. `org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.`
`cas.monitor.endpoints.jdbc.pool.timeout-millis=1000` The maximum number of milliseconds that the pool will wait for a connection to be validated as alive. `org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.`

# The encoding algorithm to use such as 'UTF-8'.
# cas.monitor.endpoints.jdbc.password-encoder.character-encoding=UTF-8

# Secret to use with {@code STANDARD}, {@code PBKDF2}, {@code BCRYPT}, {@code GLIBC_CRYPT} password encoders.
# cas.monitor.endpoints.jdbc.password-encoder.secret=

# Strength or number of iterations to use for password hashing.
# cas.monitor.endpoints.jdbc.password-encoder.strength=16

# The default auto-commit behavior of connections in the pool.
# cas.monitor.endpoints.jdbc.autocommit=false

# A non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30.
# cas.monitor.endpoints.jdbc.batch-size=100

# Attempts to do a JNDI data source look up for the data source name specified.
# cas.monitor.endpoints.jdbc.data-source-name=

# Hibernate feature to automatically validate and exports DDL to the schema.
# cas.monitor.endpoints.jdbc.ddl-auto=update

# Qualifies unqualified table names with the given catalog in generated SQL.
# cas.monitor.endpoints.jdbc.default-catalog=

# Qualify unqualified table names with the given schema/tablespace in generated SQL.
# cas.monitor.endpoints.jdbc.default-schema=

# The database dialect is a configuration setting for platform independent software (JPA, Hibernate, etc) which allows such software to translate its generic SQL statements into vendor specific DDL, DML.
# cas.monitor.endpoints.jdbc.dialect=org.hibernate.dialect.HSQLDialect

# Set the pool initialization failure timeout.
# cas.monitor.endpoints.jdbc.fail-fast-timeout=1

# Used to specify number of rows to be fetched in a select query.
# cas.monitor.endpoints.jdbc.fetch-size=100

# Allow hibernate to generate query statistics.
# cas.monitor.endpoints.jdbc.generate-statistics=false

# The SQL query to be executed to test the validity of connections.
# cas.monitor.endpoints.jdbc.health-query=

# Controls the maximum amount of time that a connection is allowed to sit idle in the pool.
# cas.monitor.endpoints.jdbc.idle-timeout=PT10M

# This property determines whether data source isolates internal pool queries, such as the connection alive test, in their own transaction.
# cas.monitor.endpoints.jdbc.isolate-internal-queries=false

# Defines the isolation level for transactions.
# cas.monitor.endpoints.jdbc.isolation-level-name=ISOLATION_READ_COMMITTED

# Controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak.
# cas.monitor.endpoints.jdbc.leak-threshold=3000

# Fully-qualified name of the class that can control the physical naming strategy of hibernate.
# cas.monitor.endpoints.jdbc.physical-naming-strategy-class-name=org.apereo.cas.hibernate.CasHibernatePhysicalNamingStrategy

# Defines the propagation behavior for transactions.
# cas.monitor.endpoints.jdbc.propagation-behavior-name=PROPAGATION_REQUIRED

# Additional settings provided by Hibernate (or the connection provider) in form of key-value pairs.
# cas.monitor.endpoints.jdbc.properties=

# Query to execute in order to authenticate users via JDBC.
# cas.monitor.endpoints.jdbc.query=

# Configures the Connections to be added to the pool as read-only Connections.
# cas.monitor.endpoints.jdbc.read-only=false

# Prefix to add to the role.
# cas.monitor.endpoints.jdbc.role-prefix=

# This property controls the keepalive interval for a connection in the pool.
# cas.monitor.endpoints.jdbc.pool.keep-alive-time=0

# Controls the maximum number of connections to keep in the pool, including both idle and in-use connections.
# cas.monitor.endpoints.jdbc.pool.max-size=18

# Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.
# cas.monitor.endpoints.jdbc.pool.max-wait=PT2S

# This property controls the maximum lifetime of a connection in the pool.
# cas.monitor.endpoints.jdbc.pool.maximum-lifetime=PT10M

# Controls the minimum size that the pool is allowed to reach, including both idle and in-use connections.
# cas.monitor.endpoints.jdbc.pool.min-size=6

# Set the name of the connection pool.
# cas.monitor.endpoints.jdbc.pool.name=

# Whether or not pool suspension is allowed.
# cas.monitor.endpoints.jdbc.pool.suspension=false

# The maximum number of milliseconds that the pool will wait for a connection to be validated as alive.
# cas.monitor.endpoints.jdbc.pool.timeout-millis=1000

Control global properties that are relevant to Hibernate, when CAS attempts to employ and utilize database resources, connections and queries.


`cas.jdbc.case-insensitive=false` When choosing physical table names, determine whether names should be considered case-insensitive.
`cas.jdbc.gen-ddl=true` Whether to generate DDL after the EntityManagerFactory has been initialized creating/updating all relevant tables.
`cas.jdbc.physical-table-names=` Indicate a physical table name to be used by the hibernate naming strategy in case table names need to be customized for the specific type of database. The key here indicates the CAS-provided table name and the value is the translate physical name for the database. If a match is not found for the CAS-provided table name, then that name will be used by default.
`cas.jdbc.show-sql=false` Whether SQL queries should be displayed in the console/logs.

If you need to design your own password encoding scheme where the type is specified as a fully qualified Java class name, the structure of the class would be similar to the following:

package org.example.cas;

import org.springframework.security.crypto.codec.*;
import org.springframework.security.crypto.password.*;

public class MyEncoder extends AbstractPasswordEncoder {
    @Override
    protected byte[] encode(CharSequence rawPassword, byte[] salt) {
        return ...
    }
}

If you need to design your own password encoding scheme where the type is specified as a path to a Groovy script, the structure of the script would be similar to the following:

import java.util.*

byte[] run(final Object... args) {
    def rawPassword = args[0]
    def generatedSalt = args[1]
    def logger = args[2]
    def casApplicationContext = args[3]

    logger.debug("Encoding password...")
    return ...
}

Boolean matches(final Object... args) {
    def rawPassword = args[0]
    def encodedPassword = args[1]
    def logger = args[2]
    def casApplicationContext = args[3]

   logger.debug("Does match or not ?");
   return ...

The following settings and properties are available from the CAS configuration catalog:


`cas.monitor.endpoints.ldap.base-dn=` Base DN to use. There may be scenarios where different parts of a single LDAP tree could be considered as base-dns. Rather than duplicating the LDAP configuration block for each individual base-dn, each entry can be specified and joined together using a special delimiter character. The user DN is retrieved using the combination of all base-dn and DN resolvers in the order defined. DN resolution should fail if multiple DNs are found. Otherwise the first DN found is returned. Usual syntax is: `subtreeA,dc=example,dc=net\|subtreeC,dc=example,dc=net`. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.bind-credential=` The bind credential to use when connecting to LDAP. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.bind-dn=` The bind DN to use when connecting to LDAP. LDAP connection configuration injected into the LDAP connection pool can be initialized with the following parameters: `bindDn/bindCredential` provided - Use the provided credentials to bind when initializing connections. `bindDn/bindCredential` set to `*` - Use a fast-bind strategy to initialize the pool. `bindDn/bindCredential` set to blank - Skip connection initializing; perform operations anonymously. SASL mechanism provided - Use the given SASL mechanism to bind when initializing connections. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.ldap-url=` The LDAP url to the server. More than one may be specified, separated by space and/or comma. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.search-filter=` User filter to use for searching. Syntax is `cn={user}` or `cn={0}`. You may also provide an external groovy script in the syntax of `file:/path/to/GroovyScript.groovy` to fully build the final filter template dynamically. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.type=AUTHENTICATED` The authentication type. `AD` - Users authenticate with `sAMAccountName`. `AUTHENTICATED` - Manager bind/search type of authentication. If { principalAttributePassword</code> is empty then a user simple bind is done to validate credentials. Otherwise the given attribute is compared with the given `principalAttributePassword` using the `SHA` encrypted value of it. `ANONYMOUS`: Similar semantics as `AUTHENTICATED` except no `bindDn` and `bindCredential` may be specified to initialize the connection. If `principalAttributePassword` is empty then a user simple bind is done to validate credentials. Otherwise the given attribute is compared with the given `principalAttributePassword` using the `SHA` encrypted value of it. DIRECT: Direct Bind - Compute user DN from format string and perform simple bind. This is relevant when no search is required to compute the DN needed for a bind operation. Use cases for this type are: 1) All users are under a single branch in the directory, `e.g. ou=Users,dc=example,dc=org.` 2) The username provided on the CAS login form is part of the DN, e.g. `uid=%s,ou=Users,dc=example,dc=org`. Available values are as follows: `AD`: Active Directory. `AUTHENTICATED`: Authenticated Search. `DIRECT`: Direct Bind. `ANONYMOUS`: Anonymous Search. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`


`cas.monitor.endpoints.ldap.allow-multiple-dns=false` Whether search/query results are allowed to match on multiple DNs, or whether a single unique DN is expected for the result. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.allow-multiple-entries=false` Set if multiple Entries are allowed. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.binary-attributes=` Indicate the collection of attributes that are to be tagged and processed as binary attributes by the underlying search resolver. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.block-wait-time=PT3S` The length of time the pool will block. By default the pool will block indefinitely and there is no guarantee that waiting threads will be serviced in the order in which they made their request. This option should be used with a blocking connection pool when you need to control the exact number of connections that can be created This settings supports the `java.time.Duration` syntax ^[?]. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.connect-timeout=PT5S` Sets the maximum amount of time that connects will block. This settings supports the `java.time.Duration` syntax ^[?]. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.connection-strategy=` If multiple URLs are provided as the ldapURL this describes how each URL will be processed. `ACTIVE_PASSIVE` First LDAP will be used for every request unless it fails and then the next shall be used. `ROUND_ROBIN` For each new connection the next url in the list will be used. `RANDOM` For each new connection a random LDAP url will be selected. `DNS_SRV` LDAP urls based on DNS SRV records of the configured/given LDAP url will be used. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.deref-aliases=` Define how aliases are de-referenced. Accepted values are: `NEVER` `SEARCHING`: dereference when searching the entries beneath the starting point but not when searching for the starting entry. `FINDING`: dereference when searching for the starting entry but not when searching the entries beneath the starting point. `ALWAYS`: dereference when searching for the starting entry and when searching the entries beneath the starting point. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.disable-pooling=false` Whether to use a pooled connection factory in components. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.dn-format=` Specify the dn format accepted by the AD authenticator, etc. Example format might be `uid=%s,ou=people,dc=example,dc=org`. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.enhance-with-entry-resolver=true` Whether specific search entry resolvers need to be set on the authenticator, or the default should be used. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.fail-fast=true` Attempt to populate the connection pool early on startup and fail quickly if something goes wrong. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.follow-referrals=true` Set if search referrals should be followed. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.hostname-verifier=DEFAULT` Hostname verification options. Available values are as follows: `DEFAULT`: Default option, forcing verification. `ANY`: Skip hostname verification and allow all. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.idle-time=PT10M` Removes connections from the pool based on how long they have been idle in the available queue. Prunes connections that have been idle for more than the indicated amount. This settings supports the `java.time.Duration` syntax ^[?]. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.keystore=` Path to the keystore used for SSL connections. Typically contains SSL certificates for the LDAP server. This setting supports the Spring Expression Language. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.keystore-password=` Keystore password. This setting supports the Spring Expression Language. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.keystore-type=` The type of keystore. `PKCS12` or `JKS`. If left blank, defaults to the default keystore type indicated by the underlying Java platform. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.max-pool-size=10` Maximum LDAP connection pool size which the pool can use to grow. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.min-pool-size=3` Minimum LDAP connection pool size. Size the pool should be initialized to and pruned to `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.name=` Name of the LDAP handler. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.page-size=0` Request that the server return results in batches of a specific size. See RFC 2696. This control is often used to work around server result size limits. A negative/zero value disables paged requests. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.pool-passivator=BIND` You may receive unexpected LDAP failures, when CAS is configured to authenticate using `DIRECT` or `AUTHENTICATED` types and LDAP is locked down to not allow anonymous binds/searches. Every second attempt with a given LDAP connection from the pool would fail if it was on the same connection as a failed login attempt, and the regular connection validator would similarly fail. When a connection is returned back to a pool, it still may contain the principal and credentials from the previous attempt. Before the next bind attempt using that connection, the validator tries to validate the connection again but fails because it’s no longer trying with the configured bind credentials but with whatever user DN was used in the previous step. Given the validation failure, the connection is closed and CAS would deny access by default. Passivators attempt to reconnect to LDAP with the configured bind credentials, effectively resetting the connection to what it should be after each bind request. Furthermore if you are seeing errors in the logs that resemble a 'Operation exception encountered, reopening connection' type of message, this usually is an indication that the connection pool’s validation timeout established and created by CAS is greater than the timeout configured in the LDAP server, or more likely, in the load balancer in front of the LDAP servers. You can adjust the LDAP server session’s timeout for connections, or you can teach CAS to use a validity period that is equal or less than the LDAP server session’s timeout. Accepted values are: `NONE`: No passivation takes place. `BIND`: The default behavior which passivates a connection by performing a bind operation on it. This option requires the availability of bind credentials when establishing connections to LDAP. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.principal-attribute-password=` If principalAttributePassword is empty then a user simple bind is done to validate credentials otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it. For the anonymous authentication type, if principalAttributePassword is empty then a user simple bind is done to validate credentials otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.prune-period=PT2H` Removes connections from the pool based on how long they have been idle in the available queue. Run the pruning process at the indicated interval. This settings supports the `java.time.Duration` syntax ^[?]. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.resolve-from-attribute=` If this attribute is set, the value found in the first attribute value will be used in place of the DN. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.response-timeout=PT5S` Duration of time to wait for responses. This settings supports the `java.time.Duration` syntax ^[?]. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.sasl-authorization-id=` SASL authorization id. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.sasl-mechanism=` The SASL mechanism. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.sasl-mutual-auth=` SASL mutual auth is enabled? `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.sasl-quality-of-protection=` SASL quality of protected. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.sasl-realm=` The SASL realm. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.sasl-security-strength=` SASL security strength. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.search-entry-handlers=` Search handlers. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.subtree-search=true` Whether subtree searching is allowed. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.trust-certificates=` Path of the trust certificates to use for the SSL connection. Ignores keystore-related settings when activated and used. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.trust-manager=` Trust Manager options. Trust managers are responsible for managing the trust material that is used when making LDAP trust decisions, and for deciding whether credentials presented by a peer should be accepted. Accepted values are: * `DEFAULT`: Enable and force the default JVM trust managers. `ANY`: Trust any client or server. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.trust-store=` Path to the keystore used to determine which certificates or certificate authorities should be trusted. Used when connecting to an LDAP server via LDAPS or startTLS connection. If left blank, the default truststore for the Java runtime is used. This setting supports the Spring Expression Language. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.trust-store-password=` Password needed to open the truststore. This setting supports the Spring Expression Language. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.trust-store-type=` The type of trust keystore that determines which certificates or certificate authorities are trusted. Types depend on underlying java platform, typically `PKCS12` or `JKS`. If left blank, defaults to the default keystore type indicated by the underlying Java platform. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.use-start-tls=false` Whether TLS should be used and enabled when establishing the connection. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.validate-on-checkout=true` Whether connections should be validated when loaned out from the pool. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.validate-period=PT5M` Period at which pool should be validated. This settings supports the `java.time.Duration` syntax ^[?]. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.validate-periodically=true` Whether connections should be validated periodically when the pool is idle. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.validate-timeout=PT5S` Period at which validation operations may time out. This settings supports the `java.time.Duration` syntax ^[?]. `org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.ldap.ldap-authz.allow-multiple-results=false` Indicate whether the LDAP search query is allowed to return multiple entries. `org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.`
`cas.monitor.endpoints.ldap.ldap-authz.base-dn=` Base DN to start the search. `org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.`
`cas.monitor.endpoints.ldap.ldap-authz.group-attribute=` Attribute expected to be found on the entry resulting from the group search whose value is going to be used to construct roles. The final value is always prefixed with `#groupPrefix`. This is useful in scenarios where you wish to grant access to a resource to all users who a member of a given group. `org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.`
`cas.monitor.endpoints.ldap.ldap-authz.group-base-dn=` Base DN to start the search looking for groups. `org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.`
`cas.monitor.endpoints.ldap.ldap-authz.group-filter=` Search filter to begin looking for groups. `org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.`
`cas.monitor.endpoints.ldap.ldap-authz.group-prefix=` A prefix that is prepended to the group attribute value to construct an authorized role. `org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.`
`cas.monitor.endpoints.ldap.ldap-authz.role-attribute=uugid` Attribute expected to be found on the entry whose value is going to be used to construct roles. The final value is always prefixed with `#rolePrefix`. This is useful in scenarios where you wish to grant access to a resource to all users who carry a special attribute. `org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.`
`cas.monitor.endpoints.ldap.ldap-authz.role-prefix=ROLE_` Prefix for the role. `org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.`
`cas.monitor.endpoints.ldap.ldap-authz.search-filter=` LDAP search filter to locate accounts. `org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.`
`cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-name-case-change=` The Attribute name case change. `org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.`
`cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-names=` The Attribute names. `org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.`
`cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-value-case-change=` The Attribute value case change. `org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.`
`cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.dn-case-change=` The Dn case change. `org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.`
`cas.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.add-if-exists=` The Add if exists. `org.apereo.cas.configuration.model.support.ldap.DnAttributeSearchEntryHandlersProperties.`
`cas.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name=entryDN` The Dn attribute name. `org.apereo.cas.configuration.model.support.ldap.DnAttributeSearchEntryHandlersProperties.`
`cas.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.attribute-names=` The Attribute names. `org.apereo.cas.configuration.model.support.ldap.MergeAttributesSearchEntryHandlersProperties.`
`cas.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name=` The Merge attribute name. `org.apereo.cas.configuration.model.support.ldap.MergeAttributesSearchEntryHandlersProperties.`
`cas.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.base-dn=` The Base dn. `org.apereo.cas.configuration.model.support.ldap.PrimaryGroupIdSearchEntryHandlersProperties.`
`cas.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.group-filter=(&(objectClass=group)(objectSid={0}))` The Group filter. `org.apereo.cas.configuration.model.support.ldap.PrimaryGroupIdSearchEntryHandlersProperties.`
`cas.monitor.endpoints.ldap.search-entry-handlers[0].recursive.merge-attributes=` The Merge attributes. `org.apereo.cas.configuration.model.support.ldap.RecursiveSearchEntryHandlersProperties.`
`cas.monitor.endpoints.ldap.search-entry-handlers[0].recursive.search-attribute=` The Search attribute. `org.apereo.cas.configuration.model.support.ldap.RecursiveSearchEntryHandlersProperties.`
`cas.monitor.endpoints.ldap.search-entry-handlers[0].type=` The type of search entry handler to choose. Available values are as follows: `ACTIVE_DIRECTORY`: Process the entry results fetched from active directory and check for account status controls for disabled/expired accounts, etc. `OBJECT_GUID`: Object guid search entry handler. Handles the `objectGUID` attribute fetching and conversion. `OBJECT_SID`: Object sid search entry handler. Handles the `objectSid` attribute fetching and conversion. `CASE_CHANGE`: Case change search entry handler. Provides the ability to modify the case of search entry DNs, attribute names, and attribute values. `DN_ATTRIBUTE_ENTRY`: DN attribute entry handler. Adds the entry DN as an attribute to the result set. Provides a client side implementation of RFC 5020. `MERGE`: Merge search entry handler. Merges the values of one or more attributes into a single attribute. `PRIMARY_GROUP`: Primary group search handler. Constructs the primary group SID and then searches for that group and puts it's DN in the `memberOf` attribute of the original search entry. `RANGE_ENTRY`: Range entry search handler. Rewrites attributes returned from Active Directory to include all values by performing additional searches. `RECURSIVE_ENTRY`: Recursive entry search handler. This recursively searches based on a supplied attribute and merges those results into the original entry. `MERGE_ENTRIES`: Merge entries handler. Merges the values of one or more attributes in all entries into a single attribute. The merged attribute may or may not already exist on the entry. If it does exist it's existing values will remain intact. `org.apereo.cas.configuration.model.support.ldap.LdapSearchEntryHandlersProperties.`
`cas.monitor.endpoints.ldap.validator.attribute-name=objectClass` Attribute name to use for the compare validator. `org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.`
`cas.monitor.endpoints.ldap.validator.attribute-value=top` Attribute values to use for the compare validator. `org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.`
`cas.monitor.endpoints.ldap.validator.base-dn=` Base DN to use for the search request of the search validator. `org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.`
`cas.monitor.endpoints.ldap.validator.dn=` DN to compare to use for the compare validator. `org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.`
`cas.monitor.endpoints.ldap.validator.scope=OBJECT` Search scope to use for the search request of the search validator. `org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.`
`cas.monitor.endpoints.ldap.validator.search-filter=(objectClass=*)` Search filter to use for the search request of the search validator. `org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.`
`cas.monitor.endpoints.ldap.validator.type=search` Determine the LDAP validator type. The following LDAP validators can be used to test connection health status: `search`: Validates a connection is healthy by performing a search operation. Validation is considered successful if the search result size is greater than zero. `none`: No validation takes place. `compare`: Validates a connection is healthy by performing a compare operation. `org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.`

# Whether search/query results are allowed to match on multiple DNs, or whether a single unique DN is expected for the result.
# cas.monitor.endpoints.ldap.allow-multiple-dns=false

# Set if multiple Entries are allowed.
# cas.monitor.endpoints.ldap.allow-multiple-entries=false

# Indicate the collection of attributes that are to be tagged and processed as binary attributes by the underlying search resolver.
# cas.monitor.endpoints.ldap.binary-attributes=

# The length of time the pool will block.
# cas.monitor.endpoints.ldap.block-wait-time=PT3S

# Sets the maximum amount of time that connects will block.
# cas.monitor.endpoints.ldap.connect-timeout=PT5S

# If multiple URLs are provided as the ldapURL this describes how each URL will be processed.
# cas.monitor.endpoints.ldap.connection-strategy=

# Define how aliases are de-referenced.
# cas.monitor.endpoints.ldap.deref-aliases=

# Whether to use a pooled connection factory in components.
# cas.monitor.endpoints.ldap.disable-pooling=false

# Specify the dn format accepted by the AD authenticator, etc.
# cas.monitor.endpoints.ldap.dn-format=

# Whether specific search entry resolvers need to be set on the authenticator, or the default should be used.
# cas.monitor.endpoints.ldap.enhance-with-entry-resolver=true

# Attempt to populate the connection pool early on startup and fail quickly if something goes wrong.
# cas.monitor.endpoints.ldap.fail-fast=true

# Set if search referrals should be followed.
# cas.monitor.endpoints.ldap.follow-referrals=true

# Hostname verification options.
# cas.monitor.endpoints.ldap.hostname-verifier=DEFAULT

# Removes connections from the pool based on how long they have been idle in the available queue.
# cas.monitor.endpoints.ldap.idle-time=PT10M

# Path to the keystore used for SSL connections.
# cas.monitor.endpoints.ldap.keystore=

# Keystore password.
# cas.monitor.endpoints.ldap.keystore-password=

# The type of keystore.
# cas.monitor.endpoints.ldap.keystore-type=

# Maximum LDAP connection pool size which the pool can use to grow.
# cas.monitor.endpoints.ldap.max-pool-size=10

# Minimum LDAP connection pool size.
# cas.monitor.endpoints.ldap.min-pool-size=3

# Name of the LDAP handler.
# cas.monitor.endpoints.ldap.name=

# Request that the server return results in batches of a specific size.
# cas.monitor.endpoints.ldap.page-size=0

# You may receive unexpected LDAP failures, when CAS is configured to authenticate using {@code DIRECT} or {@code AUTHENTICATED} types and LDAP is locked down to not allow anonymous binds/searches.
# cas.monitor.endpoints.ldap.pool-passivator=BIND

# If principalAttributePassword is empty then a user simple bind is done to validate credentials otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it.
# cas.monitor.endpoints.ldap.principal-attribute-password=

# Removes connections from the pool based on how long they have been idle in the available queue.
# cas.monitor.endpoints.ldap.prune-period=PT2H

# If this attribute is set, the value found in the first attribute value will be used in place of the DN.
# cas.monitor.endpoints.ldap.resolve-from-attribute=

# Duration of time to wait for responses.
# cas.monitor.endpoints.ldap.response-timeout=PT5S

# SASL authorization id.
# cas.monitor.endpoints.ldap.sasl-authorization-id=

# The SASL mechanism.
# cas.monitor.endpoints.ldap.sasl-mechanism=

# SASL mutual auth is enabled?
# cas.monitor.endpoints.ldap.sasl-mutual-auth=

# SASL quality of protected.
# cas.monitor.endpoints.ldap.sasl-quality-of-protection=

# The SASL realm.
# cas.monitor.endpoints.ldap.sasl-realm=

# SASL security strength.
# cas.monitor.endpoints.ldap.sasl-security-strength=

# Search handlers.
# cas.monitor.endpoints.ldap.search-entry-handlers=

# Whether subtree searching is allowed.
# cas.monitor.endpoints.ldap.subtree-search=true

# Path of the trust certificates to use for the SSL connection.
# cas.monitor.endpoints.ldap.trust-certificates=

# Trust Manager options.
# cas.monitor.endpoints.ldap.trust-manager=

# Path to the keystore used to determine which certificates or certificate authorities should be trusted.
# cas.monitor.endpoints.ldap.trust-store=

# Password needed to open the truststore.
# cas.monitor.endpoints.ldap.trust-store-password=

# The type of trust keystore that determines which certificates or certificate authorities are trusted.
# cas.monitor.endpoints.ldap.trust-store-type=

# Whether TLS should be used and enabled when establishing the connection.
# cas.monitor.endpoints.ldap.use-start-tls=false

# Whether connections should be validated when loaned out from the pool.
# cas.monitor.endpoints.ldap.validate-on-checkout=true

# Period at which pool should be validated.
# cas.monitor.endpoints.ldap.validate-period=PT5M

# Whether connections should be validated periodically when the pool is idle.
# cas.monitor.endpoints.ldap.validate-periodically=true

# Period at which validation operations may time out.
# cas.monitor.endpoints.ldap.validate-timeout=PT5S

# Indicate whether the LDAP search query is allowed to return multiple entries.
# cas.monitor.endpoints.ldap.ldap-authz.allow-multiple-results=false

# Base DN to start the search.
# cas.monitor.endpoints.ldap.ldap-authz.base-dn=

# Attribute expected to be found on the entry resulting from the group search whose value is going to be used to construct roles.
# cas.monitor.endpoints.ldap.ldap-authz.group-attribute=

# Base DN to start the search looking for groups.
# cas.monitor.endpoints.ldap.ldap-authz.group-base-dn=

# Search filter to begin looking for groups.
# cas.monitor.endpoints.ldap.ldap-authz.group-filter=

# A prefix that is prepended to the group attribute value to construct an authorized role.
# cas.monitor.endpoints.ldap.ldap-authz.group-prefix=

# Attribute expected to be found on the entry whose value is going to be used to construct roles.
# cas.monitor.endpoints.ldap.ldap-authz.role-attribute=uugid

# Prefix for the role.
# cas.monitor.endpoints.ldap.ldap-authz.role-prefix=ROLE_

# LDAP search filter to locate accounts.
# cas.monitor.endpoints.ldap.ldap-authz.search-filter=

# The Attribute name case change.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-name-case-change=

# The Attribute names.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-names=

# The Attribute value case change.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-value-case-change=

# The Dn case change.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.dn-case-change=

# The Add if exists.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.add-if-exists=

# The Dn attribute name.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name=entryDN

# The Attribute names.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.attribute-names=

# The Merge attribute name.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name=

# The Base dn.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.base-dn=

# The Group filter.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.group-filter=(&(objectClass=group)(objectSid={0}))

# The Merge attributes.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].recursive.merge-attributes=

# The Search attribute.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].recursive.search-attribute=

# The type of search entry handler to choose.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].type=

# Attribute name to use for the compare validator.
# cas.monitor.endpoints.ldap.validator.attribute-name=objectClass

# Attribute values to use for the compare validator.
# cas.monitor.endpoints.ldap.validator.attribute-value=top

# Base DN to use for the search request of the search validator.
# cas.monitor.endpoints.ldap.validator.base-dn=

# DN to compare to use for the compare validator.
# cas.monitor.endpoints.ldap.validator.dn=

# Search scope to use for the search request of the search validator.
# cas.monitor.endpoints.ldap.validator.scope=OBJECT

# Search filter to use for the search request of the search validator.
# cas.monitor.endpoints.ldap.validator.search-filter=(objectClass=*)

# Determine the LDAP validator type.
# cas.monitor.endpoints.ldap.validator.type=search

LDAP search filters can point to an external Groovy script to dynamically construct the final filter template.

The script itself may be designed as:

import org.ldaptive.*
import org.springframework.context.*

def run(Object[] args) {
    def filter = (FilterTemplate) args[0]
    def parameters = (Map) args[1]
    def applicationContext = (ApplicationContext) args[2]
    def logger = args[3]

    logger.info("Configuring LDAP filter")
    filter.setFilter("uid=something")
}

The following parameters are passed to the script:

Parameter	Description
`filter`	`FilterTemplate` to be updated by the script and used for the LDAP query.
`parameters`	Map of query parameters which may be used to construct the final filter.
`applicationContext`	Reference to the Spring `ApplicationContext` reference.
`logger`	The object responsible for issuing log messages such as `logger.info(...)`.

The following settings and properties are available from the CAS configuration catalog:


`cas.monitor.endpoints.jaas.login-config=` JAAS login resource file. `org.apereo.cas.configuration.model.core.monitor.JaasSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jaas.login-context-name=` The login context name should coincide with a given index in the login config specified. This name is used as the index to the configuration specified in the login config property. JAASTest { org.springframework.security.authentication.jaas.TestLoginModule required; </code>; In the above example, `JAASTest` should be set as the context name. `org.apereo.cas.configuration.model.core.monitor.JaasSecurityActuatorEndpointsMonitorProperties.`
`cas.monitor.endpoints.jaas.refresh-configuration-on-startup=true` If set, a call to `Configuration#refresh()` will be made by `#configureJaas(Resource)` method. `org.apereo.cas.configuration.model.core.monitor.JaasSecurityActuatorEndpointsMonitorProperties.`

Clustering

Ehcache 3.x doesn’t support distributed caching without Terracotta so using it without pointing at a Terracotta server or cluster doesn’t support using more than one CAS server at a time.

By pointing this Ehcache module at a Terracotta server then multiple CAS servers can share tickets. CAS uses autocreate to create the Terracotta cluster configuration. An easy way to run a Terracotta server is to use the docker container.

docker run --rm --name tc-server -p 9410:9410 -d \
  --env OFFHEAP_RESOURCE1_NAME=main \
  --env OFFHEAP_RESOURCE2_NAME=extra \
  --env OFFHEAP_RESOURCE1_SIZE=256 \
  --env OFFHEAP_RESOURCE2_SIZE=16 \
 terracotta/terracotta-server-oss:5.6.4

Running a Terracotta cluster on Kubernetes can be done easily using the Terracotta helm chart.

Version Compatibility

At this time, it appears that the latest Terracotta server is not compatible with Ehcache 3.9.x or higher.

Configuration

The following settings and properties are available from the CAS configuration catalog:


`cas.ticket.registry.ehcache3.crypto.encryption.key=` The encryption key. The encryption key by default and unless specified otherwise must be randomly-generated string whose length is defined by the encryption key size setting. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.`
`cas.ticket.registry.ehcache3.crypto.signing.key=` The signing key is a JWT whose length is defined by the signing key size setting. `org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.`
`cas.ticket.registry.ehcache3.enabled=true` Enabled allows this registry to be disabled on startup (so registry choice can be made at runtime). `org.apereo.cas.configuration.model.support.ehcache.Ehcache3Properties.`


`cas.ticket.registry.ehcache3.crypto.alg=AES` The signing/encryption algorithm to use. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.`
`cas.ticket.registry.ehcache3.crypto.enabled=true` Whether crypto operations are enabled. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.`
`cas.ticket.registry.ehcache3.crypto.encryption.key-size=16` Encryption key size. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.`
`cas.ticket.registry.ehcache3.crypto.signing.key-size=512` The signing key size. `org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.`
`cas.ticket.registry.ehcache3.enable-management=true` Sets whether JMX management beans are enabled for all caches. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3Properties.`
`cas.ticket.registry.ehcache3.enable-statistics=true` Sets whether statistics are enabled for all caches. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3Properties.`
`cas.ticket.registry.ehcache3.eternal=false` Sets whether elements are eternal. If eternal, timeouts are ignored and the element is never expired. False by default. When set to false then storage timeouts will be set based on the the individual caches timeouts. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3Properties.`
`cas.ticket.registry.ehcache3.max-elements-in-memory=10000` Builder that sets the maximum objects to be held in memory (0 = no limit). `org.apereo.cas.configuration.model.support.ehcache.Ehcache3Properties.`
`cas.ticket.registry.ehcache3.per-cache-size-on-disk=20MB` Per cache size of disk cache. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3Properties.`
`cas.ticket.registry.ehcache3.persist-on-disk=true` Persist data on disk when jvm is shut down if not using terracotta cluster. The caches will survive a restart. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3Properties.`
`cas.ticket.registry.ehcache3.root-directory=/tmp/cas/ehcache3` Root directory to store data if not using terracotta cluster. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3Properties.`
`cas.ticket.registry.ehcache3.terracotta.cluster-connection-timeout=150` Timeout when connecting to Terracotta cluster. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3TerracottaProperties.`
`cas.ticket.registry.ehcache3.terracotta.cluster-read-write-timeout=5` Timeout when reading or writing to/from Terracotta cluster. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3TerracottaProperties.`
`cas.ticket.registry.ehcache3.terracotta.clustered-cache-consistency=STRONG` Determine the cluster consistency. Available values are as follows: `EVENTUAL`: Indicates that the visibility of mutative operations is not guaranteed on operation completion. `STRONG`: Indicates that the visibility of mutative operations is guaranteed on operation completion. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3TerracottaProperties.`
`cas.ticket.registry.ehcache3.terracotta.default-server-resource=main` Name of default server resource on Terracotta cluster. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3TerracottaProperties.`
`cas.ticket.registry.ehcache3.terracotta.resource-pool-name=cas-ticket-pool` Name of resource pool to use on Terracotta cluster. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3TerracottaProperties.`
`cas.ticket.registry.ehcache3.terracotta.resource-pool-size=15MB` Size of resource pool on terracotta cluster. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3TerracottaProperties.`
`cas.ticket.registry.ehcache3.terracotta.terracotta-cluster-uri=` URI in format something like: `terracotta://host1.company.org:9410,host2.company.org:9410/cas-application`. Default port for terracotta (9410) is used if not specified in URI. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3TerracottaProperties.`

# The signing/encryption algorithm to use.
# cas.ticket.registry.ehcache3.crypto.alg=AES

# Whether crypto operations are enabled.
# cas.ticket.registry.ehcache3.crypto.enabled=true

# Encryption key size.
# cas.ticket.registry.ehcache3.crypto.encryption.key-size=16

# The signing key size.
# cas.ticket.registry.ehcache3.crypto.signing.key-size=512

# Sets whether JMX management beans are enabled for all caches.
# cas.ticket.registry.ehcache3.enable-management=true

# Sets whether statistics are enabled for all caches.
# cas.ticket.registry.ehcache3.enable-statistics=true

# Sets whether elements are eternal.
# cas.ticket.registry.ehcache3.eternal=false

# Builder that sets the maximum objects to be held in memory (0 = no limit).
# cas.ticket.registry.ehcache3.max-elements-in-memory=10000

# Per cache size of disk cache.
# cas.ticket.registry.ehcache3.per-cache-size-on-disk=20MB

# Persist data on disk when jvm is shut down if not using terracotta cluster.
# cas.ticket.registry.ehcache3.persist-on-disk=true

# Root directory to store data if not using terracotta cluster.
# cas.ticket.registry.ehcache3.root-directory=/tmp/cas/ehcache3

# Timeout when connecting to Terracotta cluster.
# cas.ticket.registry.ehcache3.terracotta.cluster-connection-timeout=150

# Timeout when reading or writing to/from Terracotta cluster.
# cas.ticket.registry.ehcache3.terracotta.cluster-read-write-timeout=5

# Determine the cluster consistency.
# cas.ticket.registry.ehcache3.terracotta.clustered-cache-consistency=STRONG

# Name of default server resource on Terracotta cluster.
# cas.ticket.registry.ehcache3.terracotta.default-server-resource=main

# Name of resource pool to use on Terracotta cluster.
# cas.ticket.registry.ehcache3.terracotta.resource-pool-name=cas-ticket-pool

# Size of resource pool on terracotta cluster.
# cas.ticket.registry.ehcache3.terracotta.resource-pool-size=15MB

# URI in format something like: {@code terracotta://host1.company.org:9410,host2.company.org:9410/cas-application}.
# cas.ticket.registry.ehcache3.terracotta.terracotta-cluster-uri=


`cas.ticket.registry.ehcache3.crypto.encryption.key=` The encryption key. The encryption key by default and unless specified otherwise must be randomly-generated string whose length is defined by the encryption key size setting. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.`
`cas.ticket.registry.ehcache3.crypto.signing.key=` The signing key is a JWT whose length is defined by the signing key size setting. `org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.`
`cas.ticket.registry.ehcache3.crypto.alg=AES` The signing/encryption algorithm to use. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.`
`cas.ticket.registry.ehcache3.crypto.enabled=true` Whether crypto operations are enabled. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.`
`cas.ticket.registry.ehcache3.crypto.encryption.key-size=16` Encryption key size. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.`
`cas.ticket.registry.ehcache3.crypto.signing.key-size=512` The signing key size. `org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.`

This CAS feature is able to accept signing and encryption crypto keys. In most scenarios if keys are not provided, CAS will auto-generate them. The following instructions apply if you wish to manually and beforehand create the signing and encryption keys.

Note that if you are asked to create a JWK of a certain size for the key, you are to use the following set of commands to generate the token:

wget https://raw.githubusercontent.com/apereo/cas/master/etc/jwk-gen.jar
java -jar jwk-gen.jar -t oct -s [size]

The outcome would be similar to:

{
  "kty": "oct",
  "kid": "...",
  "k": "..."
}

The generated value for k needs to be assigned to the relevant CAS settings. Note that keys generated via the above algorithm are processed by CAS using the Advanced Encryption Standard (AES) algorithm which is a specification for the encryption of electronic data established by the U.S. National Institute of Standards and Technology.

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc. When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value.S ettings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system property SKIP_CONFIG_VALIDATION that should be set to true. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

Ehcache v2 Ticket Registry

Due to the relatively unsupported status of the Ehcache 2.x code base, this module is deprecated and will likely be removed in a future CAS release. Unlike the Ehcache 3.x library, it can replicate directly between CAS servers without needing an external cache cluster (e.g. Terracotta in Ehcache 3.x).

Usage

This feature is deprecated and is scheduled to be removed in the future. If you can, consider using the Ehcache v3 ticket registry functionality in CAS to handle this integration.

Ehcache integration is enabled by including the following dependency in the WAR overlay:

<dependency>
  <groupId>org.apereo.cas</groupId>
  <artifactId>cas-server-support-ehcache-ticket-registry</artifactId>
  <version>${cas.version}</version>
</dependency>

implementation "org.apereo.cas:cas-server-support-ehcache-ticket-registry:${project.'cas.version'}"

dependencyManagement {
  imports {
    mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
  }
}

dependencies {  
  implementation "org.apereo.cas:cas-server-support-ehcache-ticket-registry"
}

This registry stores tickets using Ehcache version 2.x library.

Distributed Cache

Distributed caches are recommended for HA architectures since they offer fault tolerance in the ticket storage subsystem. A single cache instance is created to house all types of tickets, and is synchronously replicated across the cluster of nodes that are defined in the configuration.

RMI Replication

Ehcache supports RMI replication for distributed caches composed of two or more nodes. To learn more about RMI replication with Ehcache, see this resource.

Configuration

The following settings and properties are available from the CAS configuration catalog:


`cas.ticket.registry.ehcache.crypto.encryption.key=` The encryption key. The encryption key by default and unless specified otherwise must be randomly-generated string whose length is defined by the encryption key size setting. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.`
`cas.ticket.registry.ehcache.crypto.signing.key=` The signing key is a JWT whose length is defined by the signing key size setting. `org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.`
`cas.ticket.registry.ehcache3.crypto.encryption.key=` The encryption key. The encryption key by default and unless specified otherwise must be randomly-generated string whose length is defined by the encryption key size setting. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.`
`cas.ticket.registry.ehcache3.crypto.signing.key=` The signing key is a JWT whose length is defined by the signing key size setting. `org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.`
`cas.ticket.registry.ehcache.cache-manager-name=ticketRegistryCacheManager` The name of the cache manager instance. `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.config-location=` Set the location of the EhCache config file. A typical value is "/WEB-INF/ehcache.xml". Default is "ehcache.xml" in the root of the class path, or if not found, "ehcache-failsafe.xml" in the EhCache jar (default EhCache initialization). `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.enabled=true` Enabled allows this registry to be disabled on startup (so registry choice can be made at runtime). `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache3.enabled=true` Enabled allows this registry to be disabled on startup (so registry choice can be made at runtime). `org.apereo.cas.configuration.model.support.ehcache.Ehcache3Properties.`


`cas.ticket.registry.ehcache.crypto.alg=AES` The signing/encryption algorithm to use. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.`
`cas.ticket.registry.ehcache.crypto.enabled=true` Whether crypto operations are enabled. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.`
`cas.ticket.registry.ehcache.crypto.encryption.key-size=16` Encryption key size. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.`
`cas.ticket.registry.ehcache.crypto.signing.key-size=512` The signing key size. `org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.`
`cas.ticket.registry.ehcache3.crypto.alg=AES` The signing/encryption algorithm to use. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.`
`cas.ticket.registry.ehcache3.crypto.enabled=true` Whether crypto operations are enabled. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.`
`cas.ticket.registry.ehcache3.crypto.encryption.key-size=16` Encryption key size. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.`
`cas.ticket.registry.ehcache3.crypto.signing.key-size=512` The signing key size. `org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.`
`cas.ticket.registry.ehcache.disk-expiry-thread-interval-seconds=0` The interval in seconds between runs of the disk expiry thread. `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.eternal=false` Sets whether elements are eternal. If eternal, timeouts are ignored and the element is never expired. False by default. `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.loader-async=true` Whether to load the cache bootstrapper asynchronously. `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.max-chunk-size=5000000` The maximum serialized size of the elements to request from a remote cache peer during bootstrap. `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.max-elements-in-cache=0` Builder which sets the maximum number entries in cache. `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.max-elements-in-memory=10000` Builder that sets the maximum objects to be held in memory (0 = no limit). `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.max-elements-on-disk=0` Builder which sets the maximum number elements on Disk. 0 means unlimited. `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.maximum-batch-size=100` Maximum batch size for replication ops. `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.memory-store-eviction-policy=LRU` Builder which Sets the eviction policy. An invalid argument will set it to null. LRU - least recently used LFU - least frequently used FIFO - first in first out, the oldest element by creation time `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.persistence=NONE` Sets the persistence strategy. Acceptable values are: LOCALTEMPSWAP: Standard open source (non fault-tolerant) on-disk persistence. DISTRIBUTED: Terracotta clustered persistence (requires a Terracotta clustered cache) LOCALRESTARTABLE: Enterprise fault tolerant persistence NONE: No persistence `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.replicate-puts=true` Whether to replicate puts. `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.replicate-puts-via-copy=true` Whether a put should replicated by copy or by invalidation, (a remove). By copy is best when the entry is expensive to produce. By invalidation is best when we are really trying to force other caches to sync back to a canonical source like a database. An example of a latter usage would be a read/write cache being used in Hibernate. This setting only has effect if #replicateUpdates is true. `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.replicate-removals=true` Whether to replicate removes. `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.replicate-updates=true` Whether to replicate updates. `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.replicate-updates-via-copy=true` Whether an update (a put) should be by copy or by invalidation, (a remove). By copy is best when the entry is expensive to produce. By invalidation is best when we are really trying to force other caches to sync back to a canonical source like a database. An example of a latter usage would be a read/write cache being used in Hibernate. This setting only has effect if #replicateUpdates is true. `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.replication-interval=PT10S` The replication interval in milliseconds for the cache replicator. `Deprecation:` Since 6.2 This settings supports the `java.time.Duration` syntax ^[?]. `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.shared=false` Set whether the EhCache CacheManager should be shared (as a singleton at the ClassLoader level) or independent (typically local within the application). Default is "false", creating an independent local instance. NOTE: This feature allows for sharing this EhCacheManagerFactoryBean's CacheManager with any code calling CacheManager.create() in the same ClassLoader space, with no need to agree on a specific CacheManager name. However, it only supports a single EhCacheManagerFactoryBean involved which will control the lifecycle of the underlying CacheManager (in particular, its shutdown). `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.synchronous-writes=false` Sets the persistence write mode. `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache.system-props=` Allows system properties to be set prior to ehcache.xml parsing. EhCache will interpolate system properties in the ehcache xml config file e.g. ${ehCacheMulticastAddress</code>. `Deprecation:` Since 6.2 `org.apereo.cas.configuration.model.support.ehcache.EhcacheProperties.` Deprecation status is `ERROR` without a replacement setting.
`cas.ticket.registry.ehcache3.enable-management=true` Sets whether JMX management beans are enabled for all caches. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3Properties.`
`cas.ticket.registry.ehcache3.enable-statistics=true` Sets whether statistics are enabled for all caches. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3Properties.`
`cas.ticket.registry.ehcache3.eternal=false` Sets whether elements are eternal. If eternal, timeouts are ignored and the element is never expired. False by default. When set to false then storage timeouts will be set based on the the individual caches timeouts. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3Properties.`
`cas.ticket.registry.ehcache3.max-elements-in-memory=10000` Builder that sets the maximum objects to be held in memory (0 = no limit). `org.apereo.cas.configuration.model.support.ehcache.Ehcache3Properties.`
`cas.ticket.registry.ehcache3.per-cache-size-on-disk=20MB` Per cache size of disk cache. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3Properties.`
`cas.ticket.registry.ehcache3.persist-on-disk=true` Persist data on disk when jvm is shut down if not using terracotta cluster. The caches will survive a restart. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3Properties.`
`cas.ticket.registry.ehcache3.root-directory=/tmp/cas/ehcache3` Root directory to store data if not using terracotta cluster. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3Properties.`
`cas.ticket.registry.ehcache3.terracotta.cluster-connection-timeout=150` Timeout when connecting to Terracotta cluster. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3TerracottaProperties.`
`cas.ticket.registry.ehcache3.terracotta.cluster-read-write-timeout=5` Timeout when reading or writing to/from Terracotta cluster. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3TerracottaProperties.`
`cas.ticket.registry.ehcache3.terracotta.clustered-cache-consistency=STRONG` Determine the cluster consistency. Available values are as follows: `EVENTUAL`: Indicates that the visibility of mutative operations is not guaranteed on operation completion. `STRONG`: Indicates that the visibility of mutative operations is guaranteed on operation completion. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3TerracottaProperties.`
`cas.ticket.registry.ehcache3.terracotta.default-server-resource=main` Name of default server resource on Terracotta cluster. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3TerracottaProperties.`
`cas.ticket.registry.ehcache3.terracotta.resource-pool-name=cas-ticket-pool` Name of resource pool to use on Terracotta cluster. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3TerracottaProperties.`
`cas.ticket.registry.ehcache3.terracotta.resource-pool-size=15MB` Size of resource pool on terracotta cluster. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3TerracottaProperties.`
`cas.ticket.registry.ehcache3.terracotta.terracotta-cluster-uri=` URI in format something like: `terracotta://host1.company.org:9410,host2.company.org:9410/cas-application`. Default port for terracotta (9410) is used if not specified in URI. `org.apereo.cas.configuration.model.support.ehcache.Ehcache3TerracottaProperties.`

# The signing/encryption algorithm to use.
# cas.ticket.registry.ehcache.crypto.alg=AES

# Whether crypto operations are enabled.
# cas.ticket.registry.ehcache.crypto.enabled=true

# Encryption key size.
# cas.ticket.registry.ehcache.crypto.encryption.key-size=16

# The signing key size.
# cas.ticket.registry.ehcache.crypto.signing.key-size=512

# The signing/encryption algorithm to use.
# cas.ticket.registry.ehcache3.crypto.alg=AES

# Whether crypto operations are enabled.
# cas.ticket.registry.ehcache3.crypto.enabled=true

# Encryption key size.
# cas.ticket.registry.ehcache3.crypto.encryption.key-size=16

# The signing key size.
# cas.ticket.registry.ehcache3.crypto.signing.key-size=512

# The interval in seconds between runs of the disk expiry thread.
# cas.ticket.registry.ehcache.disk-expiry-thread-interval-seconds=0

# Sets whether elements are eternal.
# cas.ticket.registry.ehcache.eternal=false

# Whether to load the cache bootstrapper asynchronously.
# cas.ticket.registry.ehcache.loader-async=true

# The maximum serialized size of the elements to request from a remote cache peer during bootstrap.
# cas.ticket.registry.ehcache.max-chunk-size=5000000

# Builder which sets the maximum number entries in cache.
# cas.ticket.registry.ehcache.max-elements-in-cache=0

# Builder that sets the maximum objects to be held in memory (0 = no limit).
# cas.ticket.registry.ehcache.max-elements-in-memory=10000

# Builder which sets the maximum number elements on Disk. 0 means unlimited.
# cas.ticket.registry.ehcache.max-elements-on-disk=0

# Maximum batch size for replication ops.
# cas.ticket.registry.ehcache.maximum-batch-size=100

# Builder which Sets the eviction policy.
# cas.ticket.registry.ehcache.memory-store-eviction-policy=LRU

# Sets the persistence strategy.
# cas.ticket.registry.ehcache.persistence=NONE

# Whether to replicate puts.
# cas.ticket.registry.ehcache.replicate-puts=true

# Whether a put should replicated by copy or by invalidation, (a remove).
# cas.ticket.registry.ehcache.replicate-puts-via-copy=true

# Whether to replicate removes.
# cas.ticket.registry.ehcache.replicate-removals=true

# Whether to replicate updates.
# cas.ticket.registry.ehcache.replicate-updates=true

# Whether an update (a put) should be by copy or by invalidation, (a remove).
# cas.ticket.registry.ehcache.replicate-updates-via-copy=true

# The replication interval in milliseconds for the cache replicator.
# cas.ticket.registry.ehcache.replication-interval=PT10S

# Set whether the EhCache CacheManager should be shared (as a singleton at the ClassLoader level) or independent (typically local within the application).
# cas.ticket.registry.ehcache.shared=false

# Sets the persistence write mode.
# cas.ticket.registry.ehcache.synchronous-writes=false

# Allows system properties to be set prior to ehcache.xml parsing.
# cas.ticket.registry.ehcache.system-props=

# Sets whether JMX management beans are enabled for all caches.
# cas.ticket.registry.ehcache3.enable-management=true

# Sets whether statistics are enabled for all caches.
# cas.ticket.registry.ehcache3.enable-statistics=true

# Sets whether elements are eternal.
# cas.ticket.registry.ehcache3.eternal=false

# Builder that sets the maximum objects to be held in memory (0 = no limit).
# cas.ticket.registry.ehcache3.max-elements-in-memory=10000

# Per cache size of disk cache.
# cas.ticket.registry.ehcache3.per-cache-size-on-disk=20MB

# Persist data on disk when jvm is shut down if not using terracotta cluster.
# cas.ticket.registry.ehcache3.persist-on-disk=true

# Root directory to store data if not using terracotta cluster.
# cas.ticket.registry.ehcache3.root-directory=/tmp/cas/ehcache3

# Timeout when connecting to Terracotta cluster.
# cas.ticket.registry.ehcache3.terracotta.cluster-connection-timeout=150

# Timeout when reading or writing to/from Terracotta cluster.
# cas.ticket.registry.ehcache3.terracotta.cluster-read-write-timeout=5

# Determine the cluster consistency.
# cas.ticket.registry.ehcache3.terracotta.clustered-cache-consistency=STRONG

# Name of default server resource on Terracotta cluster.
# cas.ticket.registry.ehcache3.terracotta.default-server-resource=main

# Name of resource pool to use on Terracotta cluster.
# cas.ticket.registry.ehcache3.terracotta.resource-pool-name=cas-ticket-pool

# Size of resource pool on terracotta cluster.
# cas.ticket.registry.ehcache3.terracotta.resource-pool-size=15MB

# URI in format something like: {@code terracotta://host1.company.org:9410,host2.company.org:9410/cas-application}.
# cas.ticket.registry.ehcache3.terracotta.terracotta-cluster-uri=


`cas.ticket.registry.ehcache.crypto.encryption.key=` The encryption key. The encryption key by default and unless specified otherwise must be randomly-generated string whose length is defined by the encryption key size setting. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.`
`cas.ticket.registry.ehcache.crypto.signing.key=` The signing key is a JWT whose length is defined by the signing key size setting. `org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.`
`cas.ticket.registry.ehcache3.crypto.encryption.key=` The encryption key. The encryption key by default and unless specified otherwise must be randomly-generated string whose length is defined by the encryption key size setting. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.`
`cas.ticket.registry.ehcache3.crypto.signing.key=` The signing key is a JWT whose length is defined by the signing key size setting. `org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.`
`cas.ticket.registry.ehcache.crypto.alg=AES` The signing/encryption algorithm to use. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.`
`cas.ticket.registry.ehcache.crypto.enabled=true` Whether crypto operations are enabled. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.`
`cas.ticket.registry.ehcache.crypto.encryption.key-size=16` Encryption key size. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.`
`cas.ticket.registry.ehcache.crypto.signing.key-size=512` The signing key size. `org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.`
`cas.ticket.registry.ehcache3.crypto.alg=AES` The signing/encryption algorithm to use. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.`
`cas.ticket.registry.ehcache3.crypto.enabled=true` Whether crypto operations are enabled. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.`
`cas.ticket.registry.ehcache3.crypto.encryption.key-size=16` Encryption key size. `org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.`
`cas.ticket.registry.ehcache3.crypto.signing.key-size=512` The signing key size. `org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.`

Note that if you are asked to create a JWK of a certain size for the key, you are to use the following set of commands to generate the token:

wget https://raw.githubusercontent.com/apereo/cas/master/etc/jwk-gen.jar
java -jar jwk-gen.jar -t oct -s [size]

The outcome would be similar to:

{
  "kty": "oct",
  "kid": "...",
  "k": "..."
}

Configuration Metadata

Be Selective

YAGNI

Naming Convention

Validation

Indexed Settings

The Ehcache configuration for ehcache-replicated.xml mentioned in the config follows. Note that ${ehcache.otherServer} would be replaced by a system property: -Dehcache.otherserver=cas2.

<ehcache name="ehCacheTicketRegistryCache"
    updateCheck="false"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="http://ehcache.org/ehcache.xsd">

    <diskStore path="java.io.tmpdir/cas"/>

    <!-- Automatic Peer Discovery
    <cacheManagerPeerProviderFactory
    class="net.sf.ehcache.distribution.RMICacheManagerPeerProviderFactory"
    properties="peerDiscovery=automatic, multicastGroupAddress=230.0.0.1, multicastGroupPort=4446, timeToLive=32"
    propertySeparator="," />
    -->

    <!-- Manual Peer Discovery -->
    <cacheManagerPeerProviderFactory
        class="net.sf.ehcache.distribution.RMICacheManagerPeerProviderFactory"
        properties="peerDiscovery=manual,rmiUrls=//${ehcache.otherServer}:41001/proxyGrantingTicketsCache| \
            //${ehcache.otherServer}:41001/ticketGrantingTicketsCache|//${ehcache.otherServer}:41001/proxyTicketsCache| \
            //${ehcache.otherServer}:41001/oauthCodesCache|//${ehcache.otherServer}:41001/samlArtifactsCache| \
            //${ehcache.otherServer}:41001/oauthDeviceUserCodesCache|//${ehcache.otherServer}:41001/samlAttributeQueryCache| \
            //${ehcache.otherServer}:41001/oauthAccessTokensCache|//${ehcache.otherServer}:41001/serviceTicketsCache| \
            //${ehcache.otherServer}:41001/oauthRefreshTokensCache|//${ehcache.otherServer}:41001/transientSessionTicketsCache| \
            //${ehcache.otherServer}:41001/oauthDeviceTokensCache" />

    <cacheManagerPeerListenerFactory
        class="net.sf.ehcache.distribution.RMICacheManagerPeerListenerFactory"
        properties="port=41001,remoteObjectPort=41002" />
</ehcache>

Eviction Policy

Ehcache manages the internal eviction policy of cached objects via the idle and alive settings. These settings control the general policy of the cache that is used to store various ticket types. In general, you need to ensure the cache is alive long enough to support the individual expiration policy of tickets, and let CAS clean the tickets as part of its own cleaner.

Troubleshooting Guidelines

You will need to ensure that network communication across CAS nodes is allowed and no firewall or other component is blocking traffic.
If you are running this on a server with active firewalls, you will probably need to specify a fixed remoteObjectPort, within the cacheManagerPeerListenerFactory.
Depending on environment settings and version of Ehcache used, you may also have to adjust the shared setting .
Ensure that each cache manager specified a name that matches the Ehcache configuration itself.
You may also need to adjust your expiration policy to allow for a larger time span, specially for service tickets depending on network traffic and communication delay across CAS nodes particularly in the event that a node is trying to join the cluster.

Enterprise Single Sign-On for All

WORKERS AHEAD!

Ehcache v3 Ticket Registry

Actuator Endpoints

LDAP Scriptable Search Filter

Clustering

Configuration

Configuration Metadata

Be Selective

YAGNI

Naming Convention

Validation

Indexed Settings

Ehcache v2 Ticket Registry

Distributed Cache

RMI Replication

Configuration

Configuration Metadata

Be Selective

YAGNI

Naming Convention

Validation

Indexed Settings

Eviction Policy

Troubleshooting Guidelines